Architecture skill with Mermaid pattern documentation#11281
Merged
brooke-hamilton merged 10 commits intoradius-project:mainfrom Mar 2, 2026
Merged
Conversation
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new arch-documenter Copilot skill under .github/skills/ to help generate code-grounded architecture documentation, including reusable Mermaid diagram templates.
Changes:
- Added
arch-documenterskill definition and guidance (SKILL.md) - Added a Mermaid diagram patterns reference document with reusable templates
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/skills/arch-documenter/SKILL.md | Defines the skill’s purpose, procedure, Radius-specific context, and a recommended output format. |
| .github/skills/arch-documenter/references/mermaid-patterns.md | Provides reusable Mermaid diagram templates and diagramming tips. |
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11281 +/- ##
==========================================
+ Coverage 50.99% 51.01% +0.02%
==========================================
Files 679 679
Lines 43174 43174
==========================================
+ Hits 22015 22024 +9
+ Misses 19037 19033 -4
+ Partials 2122 2117 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
willdavsmith
approved these changes
Mar 2, 2026
DariuszPorowski
added a commit
that referenced
this pull request
Mar 2, 2026
Cherry-picked 8 commit(s) from main: ec31890 Flaky test fixes for race conditions and timing issues (#11339) 2e7a823 feat(codeowners): add on-call to manage github actions updates (#11342) 6f3a62f Add change detection to unit-tests.yaml to skip tests on doc-only changes (#11283) e184868 Add issue investigator agent from Drasi repo (#11221) 231932b Bump the github-actions group across 1 directory with 9 updates (#11341) 0a710f8 Architecture skill with Mermaid pattern documentation (#11281) 8e26c85 allow upgrade to pass when upgrading between rcs (#11351) d912167 chore(release): v0.55.0-rc6 (#11352) Signed-off-by: Dariusz Porowski <3431813+DariuszPorowski@users.noreply.github.com>
DariuszPorowski
pushed a commit
that referenced
this pull request
Mar 3, 2026
## Description
Adds the `architecture-documenter` skill to the Radius Copilot CLI with
comprehensive Mermaid diagram patterns and examples.
The prompt used to create this skill used the `/create-skill` prompt
that is currently bundled with VS Code Insiders. Here is what that
prompt was given:
```markdown
/create-skill Create a skill in the radius project that is very good at documenting application architectures.
- It is an expert at abstracting the application architecture and generating understandable mermaid diagrams.
- When asked it can go much deeper into the detailed interactions. It is especially good at producing true-to-code sequence diagrams (mermaid) and component diagrams that show entity relationships.
- It can distill ccomplex code concepts into simple to understand human readable text.
- It can dive deep into existing code, especially golang, to figure out how things work.
- It can suggest archtitectural improvements that would simplify the code.
- It can answer questions about the existing architecture
```
A follow-up prompt was useful in filling out the High Level Components
section:
```markdown
validate the "High-Level Components" section.
- Are those paths and names correct? If not, fix them.
- Are there more paths and names that should be added?
```
## Type of change
- This pull request is a minor refactor, code cleanup, test improvement,
or other maintenance task and doesn't change the functionality of Radius
(issue link optional).
## Contributor checklist
- An overview of proposed schema changes is included in a linked GitHub
issue.
- [x] Not applicable
- A design document PR is created in the [design-notes
repository](https://github.com/radius-project/design-notes/), if new
APIs are being introduced.
- [x] Not applicable
- The design document has been reviewed and approved by Radius
maintainers/approvers.
- [x] Not applicable
- A PR for the [samples
repository](https://github.com/radius-project/samples) is created, if
existing samples are affected by the changes in this PR.
- [x] Not applicable
- A PR for the [documentation
repository](https://github.com/radius-project/docs) is created, if the
changes in this PR affect the documentation or any user facing updates
are made.
- [x] Not applicable
- A PR for the [recipes
repository](https://github.com/radius-project/recipes) is created, if
existing recipes are affected by the changes in this PR.
- [x] Not applicable
## Changes
- Added arch-documenter skill with SKILL.md documentation
- Added Mermaid pattern references for architecture diagrams
---------
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
(cherry picked from commit 0a710f8)
Signed-off-by: Dariusz Porowski <3431813+DariuszPorowski@users.noreply.github.com>
12 tasks
12 tasks
nithyatsu
pushed a commit
that referenced
this pull request
Mar 3, 2026
## Description
Adds the `architecture-documenter` skill to the Radius Copilot CLI with
comprehensive Mermaid diagram patterns and examples.
The prompt used to create this skill used the `/create-skill` prompt
that is currently bundled with VS Code Insiders. Here is what that
prompt was given:
```markdown
/create-skill Create a skill in the radius project that is very good at documenting application architectures.
- It is an expert at abstracting the application architecture and generating understandable mermaid diagrams.
- When asked it can go much deeper into the detailed interactions. It is especially good at producing true-to-code sequence diagrams (mermaid) and component diagrams that show entity relationships.
- It can distill ccomplex code concepts into simple to understand human readable text.
- It can dive deep into existing code, especially golang, to figure out how things work.
- It can suggest archtitectural improvements that would simplify the code.
- It can answer questions about the existing architecture
```
A follow-up prompt was useful in filling out the High Level Components
section:
```markdown
validate the "High-Level Components" section.
- Are those paths and names correct? If not, fix them.
- Are there more paths and names that should be added?
```
## Type of change
- This pull request is a minor refactor, code cleanup, test improvement,
or other maintenance task and doesn't change the functionality of Radius
(issue link optional).
## Contributor checklist
- An overview of proposed schema changes is included in a linked GitHub
issue.
- [x] Not applicable
- A design document PR is created in the [design-notes
repository](https://github.com/radius-project/design-notes/), if new
APIs are being introduced.
- [x] Not applicable
- The design document has been reviewed and approved by Radius
maintainers/approvers.
- [x] Not applicable
- A PR for the [samples
repository](https://github.com/radius-project/samples) is created, if
existing samples are affected by the changes in this PR.
- [x] Not applicable
- A PR for the [documentation
repository](https://github.com/radius-project/docs) is created, if the
changes in this PR affect the documentation or any user facing updates
are made.
- [x] Not applicable
- A PR for the [recipes
repository](https://github.com/radius-project/recipes) is created, if
existing recipes are affected by the changes in this PR.
- [x] Not applicable
## Changes
- Added arch-documenter skill with SKILL.md documentation
- Added Mermaid pattern references for architecture diagrams
---------
Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
(cherry picked from commit 0a710f8)
Signed-off-by: Dariusz Porowski <3431813+DariuszPorowski@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds the
architecture-documenterskill to the Radius Copilot CLI with comprehensive Mermaid diagram patterns and examples.The prompt used to create this skill used the
/create-skillprompt that is currently bundled with VS Code Insiders. Here is what that prompt was given:A follow-up prompt was useful in filling out the High Level Components section:
Type of change
Contributor checklist
Changes